Macros used in display strings

Please note that the macro code is case sensitive.

Album

Name Code Mutable ? Meaning
Album file AF * Filename of the album
Album pathname AP   Full pathname of the album file with drive and directory
Album folder Af   Full pathname of the folder of the album file with drive and directory
Album title AN * The title of the album
Album comment AC * The comment of the album
Created Ac (*) The date and time the album was created
Modified Am   The date and time the album was last modified
Picture count A#   The number of pictures in the album
Visible picture count a#   The number of visible pictures (not marked as hidden) in the album
Displayed picture count V#   The number of pictures displayed in the active view
Selected picture count AS  * The number of selected pictures in the album
File version AV   The version of the album
MyAlbum version MV   The version of the running MyAlbum application
Current page PC   Current page number (only when printing an album)
Page count PN   Total number of pages (only when printing an album)
Active tab AT * The tab currently active (empty string if none selected)
Keywords AK   List of the defined keywords separated by commas
Play command Ap * The album's play command
Display mode At * Display mode of the album (hexadecimal value)

Picture filename

Name Code Mutable ? Meaning
Full pathname FP * Full pathname of the picture with drive and directory
Relative pathname RP   Full relative pathname of the picture with drive and directory
Simple filename FN   Just the name of the file with its extension
Filename w/o extension BF   The name of the file without extension
Filename extension FE   The extension of the file
Filename extension Fe   The extension of the file in lowercase
File size FS * The size of the file in byte
File size (KB) FK   The size of the file in kilobyte (1024 bytes)
File date & time FD * The date and time the file was last modified

Picture

Name Code Mutable ? Meaning
Number in album P#   The position of the picture in the current album (starting at 1)
Number in view p#   The position of the picture in the current view (starting at 1)
Full comment FC * The full comment associated to the picture
Comment first line 1C   Only the first line of the comment associated to the picture
Size PS   A synthetic display of the picture size (width x height, color depth and number of sub-images)
Width PW * Width of the picture in pixel
Height PH * Height of the picture in pixel
Bit per pixel PB * Number of bit per pixel in the picture (color depth). For videos: duration in seconds
Sub-pictures PF   Number of sub-picture (frames in an animated GIF for instance). The value is 0 outside full screen mode.
URL PU * URL defined for the picture
Play command Pp * The picture's play command
Selection Ps * Selection state of the picture (0 or 1)
Status PT * Status value of the picture
Status (hexa) Pt   Status value of the picture in hexadecimal
Keywords PK   List of the keywords defined for the picture separated by commas
Keywords Pk   List of the keywords defined for the picture separated by commas and spaces
Thumbnail width Pw   Width of the thumbnail in pixel
Thumbnail height Ph   Height of the thumbnail in pixel
Thumbnail bit per pixel Pb   Number of bit per pixel in the thumbnail (color depth).
Picture display mode PD (*) reserved
Picture delay Pd * Time the pictures is displayed in 1/10 s (-1 for using album default).
Picture transition type Py * reserved
Cropping rectangle RC * Position and size of the cropping rectangle: X,Y WxH
Cropping rectangle Rc * Position and size of the cropping rectangle: X,Y,W,H

Custom fields

Name Code Mutable ? Meaning
Name of the custom field Cn * The value of the custom field for the current picture. n is the identification number of the custom field (1 to 9 then A to Z)
Name of the custom field cn   The name of the specified custom field.

Miscellaneous

Name Code Mutable ? Meaning
Current folder TF * The complete path of the current folder.
Zoom level ZL   The current zoom level (in full screen mode).
Graphic mode FX   Display technology used: DirectX or GDI (in full screen mode).
Trim left TL   Remove the leading spaces from the generated display string
Trim right TR   Remove the trailing spaces from the generated display string
Trim right Tr   Remove the trailing spaces and line breaks from the generated display string
Left LE   Extracts the left part of a string.
Syntax: %LE[String, Number of characters to extract]
Left RI   Extracts the right part of a string.
Syntax: %RI[String, Number of characters to extract]
Length LN   Returns the number of characters of a string.
Syntax: %LN[String]
Lowercase ML   Converts all the characters in the string to lowercase characters.
Syntax: %ML[String]
Uppercase MU   Converts all the characters in the string to uppercase characters.
Syntax: %MU[String]
Script function SF * Call a script function to generate a part of the display string.
Syntax: %SF[ScriptFile, ScriptFunction]
The ScriptFunction function will be called with the following parameters:
- zAlb: a reference to the current album (an "Album" object),
- zPic: a reference to the current picture (a "Picture" object),
- zInfo: an integer value (0: read mode, 1: write mode).
The function must return the information to be inserted in the display string (it can be a string, an integer, a floating point value, a boolean or a date).
Note: loading and executing a script function can be slow, this macro should be used for Display Strings used for printing and HTML generation rather than screen display.
Rename counter KP   Value of the rename counter (to be used in the Batch Rename dialog box).
Fullscreen width SW * Width in pixel of the full-screen view.
Fullscreen height SH * Height in pixel of the full-screen view.

Special macros:

  %%   displays a single percent sign.
%|a line break.